<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Karamelo: Input Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="karamelodoxy.css" rel="stylesheet" type="text/css">
<!--  -->
<script type="text/javascript" src="karamelo_navtree_hacks.js"></script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.karamelo.org"><img alt="Logo" src="Karamelo_logo.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname"><a href="http://www.karamelo.org">Karamelo</a>
   &#160;<span id="projectnumber">714599e9</span>
   </div>
   <div id="projectbrief">Parallel Material Point Method Simulator</div>
  </td>
   <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
</td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classInput.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="classInput-members.html">List of all members</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a>  </div>
  <div class="headertitle">
<div class="title">Input Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class reads the input file and execute the instructions present in it line by line.</p>
<p>This class is the back bone of the code as it is the interface between the user and the code (through the input file). Its member functions are design in order to be able to generate variables and execute functions present in the input file. This class has <a class="el" href="classPointers.html">Pointers</a> as parent in order to be accessible from anywhere within the <a class="el" href="classMPM.html">MPM</a> class. </p>
</div><div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for Input:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classInput__inherit__graph.png" border="0" usemap="#Input_inherit__map" alt="Inheritance graph"/></div>
<map name="Input_inherit__map" id="Input_inherit__map">
<area shape="rect" id="node2" href="classPointers.html" title="{Pointers\n|# domain\l# error\l# group\l# infile\l# input\l# logfile\l# material\l# memory\l# modify\l# mpm\l# output\l# universe\l# update\l# wlogfile\l|+ Pointers()\l+ ~Pointers()\l}" alt="" coords="29,5,128,288"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:abcded03a8cb60eb071593f64656cc2bb"><td class="memItemLeft" align="right" valign="top"><a id="abcded03a8cb60eb071593f64656cc2bb"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInput.html#abcded03a8cb60eb071593f64656cc2bb">file</a> ()</td></tr>
<tr class="memdesc:abcded03a8cb60eb071593f64656cc2bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the input file line by line and pass it to <a class="el" href="classInput.html#ab5bc65bf433544abb37e6eccaa90aba1" title="Parse an input text line. ">parsev()</a>. <br /></td></tr>
<tr class="separator:abcded03a8cb60eb071593f64656cc2bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed148a9cdf1ab0cfd40fbb884457646a"><td class="memItemLeft" align="right" valign="top"><a id="aed148a9cdf1ab0cfd40fbb884457646a"></a>
double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInput.html#aed148a9cdf1ab0cfd40fbb884457646a">parse</a> (string)</td></tr>
<tr class="memdesc:aed148a9cdf1ab0cfd40fbb884457646a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deprecated function. <br /></td></tr>
<tr class="separator:aed148a9cdf1ab0cfd40fbb884457646a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab5bc65bf433544abb37e6eccaa90aba1"><td class="memItemLeft" align="right" valign="top">class Var&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInput.html#ab5bc65bf433544abb37e6eccaa90aba1">parsev</a> (string)</td></tr>
<tr class="memdesc:ab5bc65bf433544abb37e6eccaa90aba1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse an input text line.  <a href="#ab5bc65bf433544abb37e6eccaa90aba1">More...</a><br /></td></tr>
<tr class="separator:ab5bc65bf433544abb37e6eccaa90aba1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a9a155f2dd3bbe47384f8dacd2e8b4aa9"><td class="memItemLeft" align="right" valign="top"><a id="a9a155f2dd3bbe47384f8dacd2e8b4aa9"></a>
char **&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInput.html#a9a155f2dd3bbe47384f8dacd2e8b4aa9">arg</a></td></tr>
<tr class="memdesc:a9a155f2dd3bbe47384f8dacd2e8b4aa9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parsed args for command. <br /></td></tr>
<tr class="separator:a9a155f2dd3bbe47384f8dacd2e8b4aa9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a592db766a287440ae295a2bebdc604f4"><td class="memItemLeft" align="right" valign="top"><a id="a592db766a287440ae295a2bebdc604f4"></a>
CommandCreatorMap *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInput.html#a592db766a287440ae295a2bebdc604f4">command_map</a></td></tr>
<tr class="memdesc:a592db766a287440ae295a2bebdc604f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Map of the commands listed in <a class="el" href="style__command_8h_source.html">style_command.h</a>. <br /></td></tr>
<tr class="separator:a592db766a287440ae295a2bebdc604f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad882ea4f6922b9195c6f7a08b6226130"><td class="memItemLeft" align="right" valign="top"><a id="ad882ea4f6922b9195c6f7a08b6226130"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInput.html#ad882ea4f6922b9195c6f7a08b6226130">narg</a></td></tr>
<tr class="memdesc:ad882ea4f6922b9195c6f7a08b6226130"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of command args. <br /></td></tr>
<tr class="separator:ad882ea4f6922b9195c6f7a08b6226130"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02429acd9989e7d8750292cf513358ad"><td class="memItemLeft" align="right" valign="top">map&lt; string, class Var &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInput.html#a02429acd9989e7d8750292cf513358ad">vars</a></td></tr>
<tr class="separator:a02429acd9989e7d8750292cf513358ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ab5bc65bf433544abb37e6eccaa90aba1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab5bc65bf433544abb37e6eccaa90aba1">&#9670;&nbsp;</a></span>parsev()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Var Input::parsev </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>str</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Parse an input text line. </p>
<p>This function translates the input file syntax, either mathematical expressions or functions, to C++ and evaluate or execute them. </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a02429acd9989e7d8750292cf513358ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02429acd9989e7d8750292cf513358ad">&#9670;&nbsp;</a></span>vars</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">map&lt;string, class Var&gt;* Input::vars</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>List of global user variables. These variables are those created by the user through the input file. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="input_8h_source.html">input.h</a></li>
<li>input.cpp</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="classInput.html">Input</a></li>
    <li class="footer">Generated on Tue Jul 7 2020 22:31:23 for Karamelo by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
<!-- Matomo -->
<script type="text/javascript">
  var _paq = _paq || [];
  /* tracker methods like "setCustomDimension" should be called before "trackPageView" */
  _paq.push(['trackPageView']);
  _paq.push(['enableLinkTracking']);
  (function() {
    var u="//stats.sylphide-consulting.com/matomo/";
    _paq.push(['setTrackerUrl', u+'piwik.php']);
    _paq.push(['setSiteId', '20']);
    var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
    g.type='text/javascript'; g.async=true; g.defer=true; g.src=u+'piwik.js'; s.parentNode.insertBefore(g,s);
  })();
</script>
<noscript><p><img src="//stats.sylphide-consulting.com/matomo/piwik.php?idsite=20&rec=1" style="border:0;" alt="" /></p></noscript>
<!-- End Matomo Code -->
</body>
</html>
